/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package axil.compiler.ast;

import axil.api.extend.Source;
import axil.etc.NameValue;
import axil.framework.error.CompilationException;


/**
 * The base class for most AST nodes.
 */
public abstract class AbstractNode implements Node {
	private int source;	// Source ID
	private int line;	// Line in the source code where this node starts


	protected AbstractNode() {
		this.source = 0;
		this.line = 0;
	}


	protected AbstractNode(Source source) {
		this.source = source.source();
		this.line = source.line();
	}



	protected CompilationException problem(String key,
	                                       NameValue... values) {
		return new CompilationException(this, key, values);
	}


	protected CompilationException problem(Source source, String key,
	                                       NameValue... values) {
		return new CompilationException(source, key, values);
	}


	/**
	 * Get the identifier defined by this node. If this node does not define an
	 * identifier, then an exception is thrown.
	 */
	public String identity() {
		throw problem(this, "expecting-identifier");
	}


	/**
	 * Get the unique ID assigned to the source element, such as the module,
	 * function or script. If the object lives outside of source code, then
	 * zero is returned.
	 */
	public int source() {
		return source;
	}


	/**
	 * Get the line number in the original source where this object resides.
	 * If the object exists outside of source code (such as the boolean keyword
	 * "true"), then zero is returned.
	 */
	public int line() {
		return line;
	}
}
